org.springframework.mock.http.server.reactive

Class MockServerHttpRequest

java.lang.Object

org.springframework.http.server.reactive.AbstractServerHttpRequest

org.springframework.mock.http.server.reactive.MockServerHttpRequest

All Implemented Interfaces:

HttpMessage, HttpRequest, ReactiveHttpInputMessage, ServerHttpRequest

public class MockServerHttpRequest
extends AbstractServerHttpRequest

Mock extension of AbstractServerHttpRequest for use in tests without an actual server. Use the static methods to obtain a builder.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MockServerHttpRequest.BaseBuilder<B extends MockServerHttpRequest.BaseBuilder<B>> Request builder exposing properties not related to the body.
static interface	MockServerHttpRequest.BodyBuilder A builder that adds a body to the request.
private static class	MockServerHttpRequest.DefaultBodyBuilder

Nested classes/interfaces inherited from interface org.springframework.http.server.reactive.ServerHttpRequest

ServerHttpRequest.Builder

Field Summary

Fields

Modifier and Type	Field and Description
private <any>	body
private MultiValueMap<java.lang.String,HttpCookie>	cookies
private HttpMethod	httpMethod
private java.net.InetSocketAddress	remoteAddress

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MockServerHttpRequest(HttpMethod httpMethod, java.net.URI uri, java.lang.String contextPath, HttpHeaders headers, MultiValueMap<java.lang.String,HttpCookie> cookies, java.net.InetSocketAddress remoteAddress, <any> body)

Method Summary

Modifier and Type	Method and Description
static MockServerHttpRequest.BaseBuilder<?>	delete(java.lang.String urlTemplate, java.lang.Object... uriVars) Create an HTTP DELETE builder with the given url.
static MockServerHttpRequest.BaseBuilder<?>	get(java.lang.String urlTemplate, java.lang.Object... uriVars) Create an HTTP GET builder with the given url.
<any>	getBody() Return the body of the message as a Publisher.
HttpMethod	getMethod() Return the HTTP method of the request.
java.lang.String	getMethodValue() Return the HTTP method of the request as a String
<T> T	getNativeRequest() Return the underlying server response.
java.net.InetSocketAddress	getRemoteAddress() Return the remote address where this request is connected to, if available.
static MockServerHttpRequest.BaseBuilder<?>	head(java.lang.String urlTemplate, java.lang.Object... uriVars) Create an HTTP HEAD builder with the given url.
protected MultiValueMap<java.lang.String,HttpCookie>	initCookies() Obtain the cookies from the underlying "native" request and adapt those to an HttpCookie map.
static MockServerHttpRequest.BodyBuilder	method(HttpMethod method, java.lang.String urlTemplate, java.lang.Object... vars) Alternative to method(HttpMethod, URI) that accepts a URI template.
static MockServerHttpRequest.BodyBuilder	method(HttpMethod method, java.net.URI url) Create a builder with the given HTTP method and a URI.
static MockServerHttpRequest.BaseBuilder<?>	options(java.lang.String urlTemplate, java.lang.Object... uriVars) Creates an HTTP OPTIONS builder with the given url.
static MockServerHttpRequest.BodyBuilder	patch(java.lang.String urlTemplate, java.lang.Object... uriVars) Create an HTTP PATCH builder with the given url.
static MockServerHttpRequest.BodyBuilder	post(java.lang.String urlTemplate, java.lang.Object... uriVars) Create an HTTP POST builder with the given url.
static MockServerHttpRequest.BodyBuilder	put(java.lang.String urlTemplate, java.lang.Object... uriVars) Create an HTTP PUT builder with the given url.

Methods inherited from class org.springframework.http.server.reactive.AbstractServerHttpRequest

getCookies, getHeaders, getPath, getQueryParams, getURI, initQueryParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.http.server.reactive.ServerHttpRequest

mutate

Field Detail

httpMethod

private final HttpMethod httpMethod

cookies

private final MultiValueMap<java.lang.String,HttpCookie> cookies

remoteAddress

@Nullable
private final java.net.InetSocketAddress remoteAddress

body

private final <any> body

Constructor Detail

MockServerHttpRequest

private MockServerHttpRequest(HttpMethod httpMethod,
                              java.net.URI uri,
                              @Nullable
                              java.lang.String contextPath,
                              HttpHeaders headers,
                              MultiValueMap<java.lang.String,HttpCookie> cookies,
                              @Nullable
                              java.net.InetSocketAddress remoteAddress,
                              <any> body)

Method Detail

getMethod

public HttpMethod getMethod()

Description copied from interface: HttpRequest

Return the HTTP method of the request.

Returns:

the HTTP method as an HttpMethod enum value, or null if not resolvable (e.g. in case of a non-standard HTTP method)

getMethodValue

public java.lang.String getMethodValue()

Description copied from interface: HttpRequest

Return the HTTP method of the request as a String

Returns:

the HTTP method as a String

getRemoteAddress

@Nullable
public java.net.InetSocketAddress getRemoteAddress()

Description copied from interface: ServerHttpRequest

Return the remote address where this request is connected to, if available.

getBody

public <any> getBody()

Description copied from interface: ReactiveHttpInputMessage

Return the body of the message as a Publisher.

Returns:

the body content publisher

initCookies

protected MultiValueMap<java.lang.String,HttpCookie> initCookies()

Description copied from class: AbstractServerHttpRequest

Obtain the cookies from the underlying "native" request and adapt those to an HttpCookie map. The return value is turned into an immutable map and cached.

Note that this method is invoked lazily on access to AbstractServerHttpRequest.getCookies(). Sub-classes should synchronize cookie initialization if the underlying "native" request does not provide thread-safe access to cookie data.

Specified by:

initCookies in class AbstractServerHttpRequest

getNativeRequest

public <T> T getNativeRequest()

Description copied from class: AbstractServerHttpRequest

Return the underlying server response.

Note: This is exposed mainly for internal framework use such as WebSocket upgrades in the spring-webflux module.

Specified by:

getNativeRequest in class AbstractServerHttpRequest

method

public static MockServerHttpRequest.BodyBuilder method(HttpMethod method,
                                                       java.net.URI url)

Create a builder with the given HTTP method and a URI.

Parameters:

method - the HTTP method (GET, POST, etc)

url - the URL

Returns:

the created builder

method

public static MockServerHttpRequest.BodyBuilder method(HttpMethod method,
                                                       java.lang.String urlTemplate,
                                                       java.lang.Object... vars)

Alternative to method(HttpMethod, URI) that accepts a URI template.

Parameters:

method - the HTTP method (GET, POST, etc)

urlTemplate - the URL template

vars - variables to expand into the template

Returns:

the created builder

get

public static MockServerHttpRequest.BaseBuilder<?> get(java.lang.String urlTemplate,
                                                       java.lang.Object... uriVars)

Create an HTTP GET builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

head

public static MockServerHttpRequest.BaseBuilder<?> head(java.lang.String urlTemplate,
                                                        java.lang.Object... uriVars)

Create an HTTP HEAD builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

post

public static MockServerHttpRequest.BodyBuilder post(java.lang.String urlTemplate,
                                                     java.lang.Object... uriVars)

Create an HTTP POST builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

put

public static MockServerHttpRequest.BodyBuilder put(java.lang.String urlTemplate,
                                                    java.lang.Object... uriVars)

Create an HTTP PUT builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

patch

public static MockServerHttpRequest.BodyBuilder patch(java.lang.String urlTemplate,
                                                      java.lang.Object... uriVars)

Create an HTTP PATCH builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

delete

public static MockServerHttpRequest.BaseBuilder<?> delete(java.lang.String urlTemplate,
                                                          java.lang.Object... uriVars)

Create an HTTP DELETE builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder

options

public static MockServerHttpRequest.BaseBuilder<?> options(java.lang.String urlTemplate,
                                                           java.lang.Object... uriVars)

Creates an HTTP OPTIONS builder with the given url.

Parameters:

urlTemplate - a URL template; the resulting URL will be encoded

uriVars - zero or more URI variables

Returns:

the created builder